ISUP Body Manipulation
| ● | For certain ISUP call actions, see also Special Actions using X-AC-Action SIP Header. |
| ● | For message manipulation, optional ISUP parameters must be validated to ensure they exist and that the relevant field is not empty (i.e., meets the rule condition) before any modification is performed. For example, the following condition verifies that the 'digits' field in the Generic Number parameter is not empty: body.isup.iam.generic_num.digits != ''. |
|
SIP Method |
ISUP Message Type |
Parameter |
Field |
Syntax |
|||
|---|---|---|---|---|---|---|---|
|
INVITE |
IAM |
Called party number |
Number Plan (see Number Plan) |
body.isup.iam.called_num.plan |
|||
|
Number Type (see Number Type) |
body.isup.iam.called_num.type |
||||||
|
Address signal (string of up to 50 characters) |
body.isup.iam.called_num.digits |
||||||
|
Internal Network Number indicator (INN)
|
body.isup.iam.called_num.inn |
||||||
|
Calling party number |
Number Plan (see Number Plan) |
body.isup.iam.calling_num.plan |
|||||
|
Number Type (see Number Type) |
body.isup.iam.calling_num.type |
||||||
|
Address presentation restricted indicator (see Address Presentation Restricted Indicator) |
body.isup.iam.calling_num.presentation |
||||||
|
Screening indicator (see Screen) |
body.isup.iam.calling_num.screening |
||||||
|
Address signal (string of up to 50 characters) |
body.isup.iam.calling_num.digits |
||||||
|
Original Called Number |
Number Plan (see Number Plan) |
body.isup.iam. original_called_num.plan |
|||||
|
Number Type (see Number Type) |
body.isup.iam. original_called_num.type |
||||||
|
Address presentation restricted indicator (see Address Presentation Restricted Indicator) |
body.isup.iam.original_called_num.presentation |
||||||
|
Address signal (string of up to 50 characters) |
body.isup.iam.original_called_num.digits |
||||||
|
Generic Number |
Number qualifier indicator (see Q.763.3.26) |
body.isup.iam.generic_num.qualifier |
|||||
|
Number Plan (see Number Plan) |
body.isup.iam.generic_num.plan |
||||||
|
Number Type (see Number Type) |
body.isup.iam.generic_num.type |
||||||
|
Address presentation restricted indicator (see Address Presentation Restricted Indicator) |
body.isup.iam.generic_num.presentation |
||||||
|
Screening indicator (see Screen) |
body.isup.iam.generic_num.screening |
||||||
|
Address signal (string of up to 50 characters) |
body.isup.iam.generic_num.digits |
||||||
|
Location Number |
Number Plan (see Number Plan) |
body.isup.iam.location_num.plan |
|||||
|
Number Type (see Number Type) |
body.isup.iam.location_num.type |
||||||
|
Address presentation restricted indicator (see Address Presentation Restricted Indicator) |
body.isup.iam.location_num.presentation |
||||||
|
Screening indicator (see Screen) |
body.isup.iam.location_num.screening |
||||||
|
Address signal (string of up to 50 characters) |
body.isup.iam.location_num.digits |
||||||
|
Internal Network Number indicator (INN)
|
body.isup.iam.location_num.inn |
||||||
|
Redirecting number |
Number Plan (see Number Plan) |
body.isup.iam.redirecting_num.plan |
|||||
|
Number Type (see Number Type) |
body.isup.iam.redirecting_num.type |
||||||
|
Address presentation restricted (see Address Presentation Restricted Indicator) |
body.isup.iam.redirecting_num.presentation |
||||||
|
Address signal (string of up to 50 characters) |
body.isup.iam.redirecting_num.digits |
||||||
|
Redirection information |
Redirecting reason (see Reason (Diversion)) |
body.isup.iam.redirect.info.reason |
|||||
|
Original Redirect reason - values 1, 2, and 3 (see Redirect Reason) |
body.isup.iam.redirect_info.orig_reason |
||||||
|
Redirection Counter Number of redirections the call has undergone expressed as a number from 1 to 5. |
body.isup.iam.redirect_info.counter |
||||||
|
Redirecting Indicator (see Q.763.3.45) |
body.isup.iam.redirect_info.indicator |
||||||
|
Forward call indicator (see Q.763 3.23) |
National/international call indicator |
body.isup.iam.fci.InterationalInd |
|||||
|
End-to-end method indicator |
body.isup.iam.fci.End2EndMethod |
||||||
|
Interworking indicator |
body.isup.iam.fci.Interworking |
||||||
|
End-to-end information indicator |
body.isup.iam.fci.End2EndInformation |
||||||
|
ISDN user part indicator |
body.isup.iam.fci.IsdnUserPartIndicator |
||||||
|
ISDN user part preference indicator |
body.isup.iam.fci.IsdnUserPartPreference |
||||||
|
ISDN access indicator |
body.isup.iam.fci.IsdnAccess |
||||||
|
SCCP method indicator |
body.isup.iam.fci.SCCP |
||||||
|
Transmission medium requirement (see Transmission Medium Requirement) |
|
body.isup.iam.tmr |
|||||
|
Calling party's category (see Called Party Category Indicator) |
|
body.isup.iam.cpc |
|||||
|
Hop Counter (1 to 31) |
|
body.isup.iam.hop_counter |
|||||
|
Access transport Low layer compatibility information element (see 4.5.19 of Recommendation Q.931) |
Information transfer rate |
body.isup.iam.access_transport.transfer_rate |
|||||
|
User information layer 1 protocol |
body.isup.iam.access_transport. layer1_protocol |
||||||
|
User rate |
body.isup.iam.access_transport.user_rate |
||||||
|
User service information (see 3.57 of Q.763) |
Information transfer capability |
body.isup.iam.user_service. transfer_capability |
|||||
|
Information transfer rate |
body.isup.iam.user_service.transfer_rate |
||||||
|
User information Layer 1 protocol (usually used for analogue modem calls) |
body.isup.iam.user_service.user_info_l1 |
||||||
|
Layer ident (usually used for analogue modem calls) |
body.isup.iam.user_service.layer_id |
||||||
|
First 18x |
ACM |
Backward call indicator |
Charge indicator (see Charge Indicator) |
body.isup.acm.bci.charge |
|||
|
Called party's status indicator (see Called Party Status Indicator) |
body.isup.acm.bci.status |
||||||
|
Called party's category indicator (see Called Party Category Indicator) |
body.isup.acm.bci.cpc
|
||||||
|
End-to-end method indicator (see Q.763.3.5) |
body.isup.acm.bci.End2EndMethod
|
||||||
|
Interworking indicator (see Q.763.3.5) |
body.isup.acm.bci.Interworking |
||||||
|
End-to-end information indicator (see Q.763.3.5) |
body.isup.acm.bci.End2EndInformation |
||||||
|
ISDN user part indicator (see Q.763.3.5) |
body.isup.acm.bci.IsdnUserPartIndicator |
||||||
|
Holding indicator (see Q.763.3.5) |
body.isup.acm.bci.HoldingIndicator |
||||||
|
ISDN access indicator (see Q.763.3.5) |
body.isup.acm.bci.IsdnAccess |
||||||
|
Echo control device indicator (see Q.763.3.5) |
body.isup.acm.bci.Echo |
||||||
|
SCCP method indicator (see Q.763.3.5) |
body.isup.acm.bci.SCCP |
||||||
|
Optional Backward Call indicators |
In-band information indicator (see Q.763.3.37) |
Body.isup.acm.obci.Inband |
|||||
|
Call diversion may occur indicator (see Q.763.3.37) |
body.isup.acm.obci.diversion |
||||||
|
Simple segmentation indicator (see Q.763.3.37) |
body.isup.acm.obci.segmentation |
||||||
|
MLPP user indicator (see Q.763.3.37) |
body.isup.acm.obci.MLPP |
||||||
|
Not First 18x |
CPG |
Event Information, can be used only in condition, (see Event Information) |
|
body.isup.cpg.event_info |
|||
|
Backward Call Indicator (to send it cpc, must be set manually by message manipulation) |
Charge indicator (see Charge Indicator) |
body.isup.cpg.bci.charge |
|||||
|
Called party's status indicator (see Called Party Status Indicator) |
body.isup.cpg.bci.status |
||||||
|
Called party's category indicator (see Called Party Category Indicator) |
body.isup.cpg.bci.cpc |
||||||
|
End-to-end method indicator (see Q.763.3.5) |
body.isup.cpg.bci.End2EndMethod |
||||||
|
Interworking indicator (see Q.763.3.5) |
body.isup.cpg.bci.Interworking |
||||||
|
End-to-end information indicator (see Q.763.3.5) |
body.isup.cpg.bci.End2EndInformation |
||||||
|
ISDN user part indicator (see Q.763.3.5) |
body.isup.cpg.bci.IsdnUserPartIndicator |
||||||
|
Holding indicator (see Q.763.3.5) |
body.isup.cpg.bci.HoldingIndicator |
||||||
|
ISDN access indicator (see Q.763.3.5) |
body.isup.cpg.bci.IsdnAccess |
||||||
|
Echo control device indicator (see Q.763.3.5) |
body.isup.cpg.bci.Echo |
||||||
|
SCCP method indicator (see Q.763.3.5) |
body.isup.cpg.bci.SCCP |
||||||
|
Optional Backward Call Indicators (sent only if at least one of the fields is explicitly set by a message manipulation rule) |
In-band information indicator (see Q.763.3.37) |
body.isup.cpg.obci.inband |
|||||
|
Call diversion may occur indicator (see Q.763.3.37) |
body.isup.cpg.obci.diversion |
||||||
|
Simple segmentation indicator (see Q.763.3.37) |
body.isup.cpg.obci.segmentation |
||||||
|
MLPP user indicator (see Q.763.3.37) |
body.isup.cpg.obci.mlpp |
||||||
|
200 OK on INVITE |
ANM |
Connected number |
Number Plan (see Number Plan) |
body.isup.iam.connected_num.plan |
|||
|
Number Type (see Number Type) |
body.isup.iam.connected_num.type |
||||||
|
Address presentation restricted (see Address Presentation Restricted Indicator) |
body.isup.iam.connected_num.presentation |
||||||
|
Address signal (string of up to 50 characters) |
body.isup.iam.connected_num.digits |
||||||
|
200 OK on INVITE |
CON (for Spirou variant only, sent if SIP 18x wasn’t sent before 200 reply) |
Backward call indicator |
Charge indicator (see Charge Indicator) |
body.isup.con.bci.charge |
|||
|
Called party's status indicator (see Called Party Status Indicator) |
body.isup.con.bci.status |
||||||
|
Called party's category indicator (see Called Party Category Indicator) |
body.isup.con.bci.cpc |
||||||
|
End-to-end method indicator (see Q.763.3.5) |
body.isup.con.bci.end2endmethod |
||||||
|
Interworking indicator (see Q.763.3.5) |
body.isup.con.bci.interworking |
||||||
|
End-to-end information indicator (see Q.763.3.5) |
body.isup.con.bci.end2endinformation |
||||||
|
ISDN user part indicator (see Q.763.3.5) |
body.isup.con.bci.isdnuserpartindicator |
||||||
|
Holding indicator (see Q.763.3.5) |
body.isup.con.bci.holdingindicator |
||||||
|
ISDN access indicator (see Q.763.3.5) |
body.isup.con.bci.isdnaccess |
||||||
|
Echo control device indicator (see Q.763.3.5) |
body.isup.con.bci.echo |
||||||
|
SCCP method indicator (see Q.763.3.5) |
body.isup.con.bci.sccp |
||||||
|
INFO |
FAC |
Transfer number |
Number Plan (see Number Plan) |
body.isup.fac.connected_num.plan |
|||
|
Number Type (see Number Type) |
body.isup.fac.connected_num.type |
||||||
|
Address presentation restricted (see Address Presentation Restricted Indicator) |
body.isup.fac.connected_num.presentation |
||||||
|
Address signal (string of up to 50 characters) |
body.isup.fac.connected_num.digits |
||||||
|
BYE, 4xx |
REL |
Cause value (see Cause Value) |
|
body.isup.rel.cause |
|||
|
Cause location (see Cause Location) |
|
body.isup.rel.location |